home *** CD-ROM | disk | FTP | other *** search
/ By Popular Request 2.0 / By Popular Request 2.0 (Arsenal Computer).ISO / amiga_6 / tread2_5.lha / TurboRead.Doc < prev    next >
Text File  |  1995-02-09  |  17KB  |  390 lines
  1.                           TubroRead 2.4  for DLG BBS/OS
  2.                                 (pd)  1994-95 by
  3.                            Doug McLean  &  Bob Stouder
  4.  
  5.  
  6. What It Is
  7. ~~~~~~~~~~
  8. TurboRead started as a little hack by Doug Mclean called TagRead. It was
  9. orginially designed  to be a more convenient way  of tagging and reading
  10. messages.   Doug kept improving it and changed the name to TurboRead.
  11.  
  12. Recently, Doug released the source code for TurboRead.  I've always used
  13. TurboRead on my BBS and really liked it.  I wanted to make it more of a
  14. complete replacement for the DLG:Mess program and more intergated into
  15. DLG by using the DLG library.
  16.  
  17. TurboRead will show you a full screen of message headers at once. You may
  18. cursor up and down through the list, and read in any order you wish.  You
  19. may tag messages or message chains that can be read from the  DLG message
  20. menu.  You can change Messages areas within TurboRead,  you can enter new
  21. messages and reply to messages that you read.   You can search for a text
  22. string (including wild cards)  anywhere in the  From, To,  Title  or Body
  23. of the message.
  24.  
  25. To use TurboRead you will need ADos 2.04, a screen width of 80 columns or
  26. more and a minimum of 8 lines.  If the user doesn't have one these,
  27. TurboRead will give them an error message and exit.
  28.  
  29.  
  30. Setting It Up
  31. ~~~~~~~~~~~~~
  32. Step 1:  Create a menu entry on your message menu for TurboRead. It should
  33.          look something like this:
  34.  
  35.          [ 1] Letter:           V
  36.          [ 2] Executable:       Doors:TurboRead  <--- See Note Below
  37.          [ 4] Description:      TurboRead
  38.          [ 5] Type:             Executable
  39.          [ 6] Help File:        MSG_MAIN/V
  40.          [ 7] Lower level:      1
  41.          [ 8] Higher level:     255
  42.          [ 9] Hidden:           NO
  43.          [10] Load Type:        CHAIN            <--- Very Important!
  44.          [11] Ask user if sure: NO
  45.          [12] Pend messages:    YES              <--- Very Important!
  46.          [13] Cli Mode:         NO               <--- Very Important!
  47.          [15] Log Value:        None
  48.          [16] Activity String:  Using TurboRead
  49.          [17] Priority:         DEFAULT
  50.          [18] Edit help file
  51.  
  52.          Note: You may place any command arguments you wish on item 2 above.
  53.                These will be passed back to DLG:Mess when TurboRead exits.
  54.                For instance, I use:
  55.  
  56.                           Doors:TurboRead -c "~"
  57.  
  58.                to cause DLG:Mess to not divert to the user's private mail
  59.                area, even if they have unread private mail. Any DLG switches
  60.                will be substituted at the time that TurboRead is executed
  61.                NOT when it returns to DLG:Mess.
  62.  
  63.          Note: If you use forced Message SIGs (ie DLG:Mess -s nnn) then you
  64.                must also call TurboRead with that Message SIG on the command
  65.                line:
  66.                           Doors:TurboRead -s %MSG_SIGNUMBER
  67.  
  68.                Other arguments may be present on the command line as stated
  69.                above.  The SIG and any other arguments will be passed back
  70.                to DLG:Mess.
  71.  
  72.          Note: DON'T COPY THIS VERSION OF TURBOREAD OVER YOUR OLD ONE WITHOUT
  73.                MAKING THE MENU CHANGES SHOWN ABOVE.  USING THE OLD MENU BATCH
  74.                FILE WITH THIS VERSION OF TURBOREAD WILL CAUSE PROBLEMS AND
  75.                IT WON'T WORK CORRECTLY.
  76.  
  77.  
  78. Step 2:  Copy the file Tagged.Txt to DLGConfig:Text.
  79.          Modify as apporiate for your system.
  80.  
  81. Step 3:  Copy the TagRead#?.bat files to DLGConfig:batch.
  82.          Modify the TagRead#?.bat files as apporiate for your system.
  83.  
  84. Step 4:  Copy the executable programs to Doors: or where ever you keep them.
  85.  
  86.  
  87.  
  88.  
  89. Using TurboRead
  90. ~~~~~~~~~~~~~~~
  91. Ok, now you should have everything set up and ready to go.  Please view the
  92. included screen picture (TurboRead.pic) for the rest of the discussion.
  93.  
  94. At the top, you are shown the number and name of the message area.  At the
  95. far right, you are shown the number of the next unread message and the number
  96. of the lowest and highest messages in the area.  After the message numbers,
  97. is your "write" status in this message area.  If you can write messages, then
  98. "Enterable" will appear, if you can't then "Read Only" will appear.
  99.  
  100. The second line shows the most commonly used commands and the search text.
  101. The third line is the message heading line. Messages are displayed starting
  102. on the fourth line.
  103.  
  104. The placement of the cursor determines what is the current message.  The
  105. message number will be shown in reverse video.  I did this to make it easier
  106. to track where the current message is in relationship to the From, To and
  107. Title fields.  This way you have a visual reference to the current message
  108. on each side of the screen.
  109.  
  110. Up         arrow moves the cursor up a line.
  111.  
  112. Shift-Up   arrow move to top of screen.
  113.  
  114. Down       arrow moves it down a line.
  115.  
  116. Shift-Down arrow move to bottom of screen.
  117.  
  118. Left       arrow goes to the previous page of messages.
  119.  
  120. Right      arrow goes to the next page.
  121.  
  122. Note:      In place of the arrow keys, you can also use the number keys
  123.            (8, 2, 4, and 6). These perform the same function as the arrows
  124.            on your numeric keypad. This is useful for users whose terminal
  125.            programs don't properly support the arrow keys, and for Messy-Dos
  126.            users who can't figure out how their Num-Lock key works.  Also,
  127.            the number key 7 moves to Top of Screen and 1 moves to bottom of
  128.            screen.
  129.  
  130.  
  131. R or RETURN will read the message that the cursor is on.  After reading a
  132.             message, the cursor is automatically advanced to the next NEW
  133.             message.  I did this to make reading new messages more convenient.
  134.             A user can read new messages by pressing RETURN, similar to the
  135.             way DLG:Mess does it.  If there are NO NEW messages, the cursor
  136.             stays on the current message.
  137.  
  138.             After reading a message, there are up to seven choices.
  139.  
  140.                   ! = will always reread the current message.
  141.  
  142.                   - = will display the message that this message
  143.                       is a reply to (the parent message).  If there
  144.                       is no parent message, this option will not
  145.                       display or execute.
  146.  
  147.                   + = will display the reply to this message (the child).
  148.                       If there is no reply, this option will not display
  149.                       or execute.
  150.  
  151.                   R = will allow replying to the message. If the user
  152.                       does not have write access in the area, then this
  153.                       option will not display or execute.
  154.  
  155.                   C = will allow correcting the message. If the user
  156.                       does not have re-Edit access in the area, then this
  157.                       option will not display or execute.
  158.  
  159.                   B = will display a list of batch files and allow the user
  160.                       to execute one. This option will not display or execute
  161.                       if there are no batch files or the user doesn't have
  162.                       access to any batch files.
  163.  
  164.                   Any other key will return to the message display screen.
  165.  
  166.  
  167. E allows the user to enter a new message.
  168.  
  169. . or SPACEBAR will tag or untag the current message. If the message is
  170.               already tagged, it will be deleted.  If it's not tagged,
  171.               it will be added.
  172.  
  173. X will clear all message tags, EVEN THOSE TAGGED BEFORE ENTERING TurboRead.
  174.   Utilities like WMail tag messages, and the user might have tagged messages
  175.   himself, but TurboRead has no way of knowing who tagged what. So, if a user
  176.   clears tagged messages, all of the tags are cleared.
  177.  
  178. A allows you to change message areas.  If you were in a SIG before executing
  179.   TurboRead, then only those areas of the SIG will be available you.
  180.  
  181.   The Message areas that you have access to be displayed and the cursor will
  182.   be positioned on the first message area.  Just like the message display
  183.   screen, the current selected message area's number will be in reverse video.
  184.  
  185.   You may position to any message area using the arrow keys or the numeric
  186.   keypad keys (8,2,4,6,7,1).  Position on the message area desired and press
  187.   RETURN to select it.  To select your private mail area, press the P key.
  188.   If more areas are available than will fit on the screen, pressing the M
  189.   key will display the next screen.  Pressing the B key will display the
  190.   first screen of message areas.  Pressing the A key will abort the Area
  191.   change and return to the Message display screen.
  192.  
  193. N allows you to do a New Message scan. It will scan your Message Global Areas,
  194.   stopping on the next Message area with new messages.  While it is scaning
  195.   for new messages, a Control-C will abort the scan and return you to the
  196.   message display screen.
  197.  
  198. K allows you to delete a message.  You may always delete messages in your
  199.   private mail area.  In other message areas, you may only delete messages
  200.   if your level is within the low-high kill levels for that message area.
  201.  
  202. F allows you to add a name to the message Twit Filter.  The name defaults
  203.   to the from name of the message that the cursor is on.  However, the
  204.   name may be changed.  A name may be filtered out in the current message
  205.   area or ALL areas.  A name may be filtered from mutiple message areas
  206.   (but not all areas) by going to each area and adding the name for that
  207.   area.  If a name is added for ALL area filtering, any previously defined
  208.   message area filters are deleted.
  209.  
  210. D will display ALL names and associated message areas in the Twit filter. A
  211.   name may be up to 35 characters, but due to limited display space only the
  212.   first 30 characters will be displayed.  However all 35 characters will be
  213.   used to filter and delete names.
  214.  
  215.   You may position to any name using the arrow keys or the numeric keypad
  216.   keys (8,2,4,6,7,1).  Position on the name to delete and press RETURN to
  217.   delete it.  If more names are available than will fit on the screen pressing
  218.   the M key will display the next screen.  Pressing the B key will display the
  219.   first screen of names.  Pressing the A key will abort the screen and return
  220.   to the Message display screen.
  221.  
  222. H will show a brief help screen.  Help is available on all screens.  The help
  223.   displayed will pertain to that screen only.
  224.  
  225. ? will redraw the screen. Good if you get a bit of garbage on the line or
  226.   the two minute warning.
  227.  
  228. # will update the users last read message number to the highest message in
  229.   this area.
  230.  
  231. C will clear the search string.
  232.  
  233. S will allow the user to enter/edit the search string.  Searches are done on
  234.   the From, To, Title and the Message body (up to the SEEN-BY line).  Wild
  235.   cards are allowed in the search string. (see the help screen for examples).
  236.  
  237. Q exits TurboRead.
  238.  
  239.  
  240. TurbRead Flags & Colors
  241. ~~~~~~~~~~~~~~~~~~~~~~~
  242. On the right side of each message is a series of flags.  If the user has ANSI
  243. color, then parts of the message will be displayed in different colors.
  244.  
  245. Flags show same information as colors:
  246.  
  247.     S----   Search String Found   (White From, To, Title or S=found in body)
  248.     -T---   Tagged Message        (White  Message Number)
  249.     --R--   Reply To/Next Reply   (Purple Message Number)
  250.     ---2-   Message  to  You      (Cyan To)
  251.     ---Y-   Message From You      (Cyan From)
  252.     ----L   Last Message Read     (Purple To, From, Title)
  253.     ----N   Next Unread Message   (Yellow To, From, Title)
  254.  
  255.  
  256. The number of a message will either be green, white, or purple:
  257.  - A white number means that the message is tagged.
  258.  - A purple number means that the message is either a reply to the message
  259.    you last read, or the message you last read is a reply to the one with
  260.    the purple number.
  261.  
  262. The To, From, and Title fields:
  263.  - White means it matches the search string.
  264.  - Purple is the last message you have read.
  265.  - Yellow is the next unread message.
  266.  
  267. The following colors have priority over the ones above, where applicable:
  268.  - If your name appears in To or From, it will appear in Cyan. 
  269.  
  270.  
  271. TurboRead Batch Files
  272. ~~~~~~~~~~~~~~~~~~~~~
  273. After reading a message the user can execute one of 9 different batch files.
  274. These batch files must be located in DLGConfig:batch/, and are called
  275. TagReadx.bat, where x is from 1 to 9,  EX: DLGConfig:batch/TagRead1.bat.
  276.  
  277. The batch files can provide valuable services, like exporting messages, tagging
  278. a thread, etc.  The batch files provided perform the following functions:
  279.  
  280.      1:  Saves a message as text to be downloaded.
  281.      2:  Tag the entire message thread starting with the current message.
  282.      3:  Show message Kludge lines.
  283.      4:  Lex Check Message.
  284.      5:  Not provided -- Make your own.
  285.      6:  Extracts a UUencoded file from a message.
  286.      7:  Write Message to Printer.
  287.      8:  Export Message to a text file.
  288.      9:  Sample Batch.
  289.  
  290. The best place to put the utilities used by any of the above batch files
  291. you wish to keep online is in Doors: and these sample batches ASSUME that.
  292. These batch files are intended as examples only!  YOU NEED TO EDIT MOST OF
  293. THE ABOVE FOR YOUR SYSTEM!
  294.  
  295. WARNING: There is very little (if any) error checking done on the format
  296.          of your batch files, SO GET THEM RIGHT before putting them online!
  297.  
  298.  
  299. When a batch file is executed, it is passed 6 arguments.  These are:
  300.  
  301.      1:  The full name and path of the current message.
  302.      2:  The Underscored user name.
  303.      3.  The Message area number.
  304.      4.  The Message number.
  305.      5.  The Message Area Name.
  306.      6.  The Port that the User is on.
  307.  
  308. With this information available, it should be possible to do just about
  309. whatever you want to a message. If you write or find any utilities that
  310. are useful in TurboRead batch files, please send them to me!
  311.  
  312. NOTE THAT YOU CANNOT GET INPUT FROM THE USER in a batch file, do not use
  313. any program that expects input.
  314.  
  315. We need to provide some additional information about a batch file to TurboRead.
  316. A priviledge level and a description of the batch file's function.  TurboRead
  317. will read the batch file, find and use the first TWO comment lines.
  318.  
  319. The first comment line MUST contain the minimum user level required to execute
  320. the batch file.  This is shown on Line 4 in the sample batch file below. Only
  321. those batch files that a user has access to will be displayed to the user.
  322.  
  323. The second comment line MUST contain a description (of up to 60 chars) of the
  324. batch file's function.  This is shown on Line 5 in the sample batch file below.
  325.  
  326.  
  327. Sample Batch File:
  328.     .key msg/a,user/a,anum/a,mnum/a,aname/a,port/a
  329.     .bra [
  330.     .ket ]
  331.     ;255
  332.     ;Sample    - Sample batch file for TagRead (Sysop)
  333.     ;
  334.     ; This sample batch file will print all the info passed to the batch file.
  335.     ;
  336.     ; DO NOT change line 1.
  337.     ;
  338.     ; Change lines 2 & 3 ONLY if you do not want to use [ and ] to contain
  339.     ; the data passed to the batch file.
  340.     ;
  341.     ; Line 4 MUST contain the minimum user level required to execute the
  342.     ; batch file.
  343.     ;
  344.     ; Line 5 MUST contain a SHORT description of the batch file (60 chars max).
  345.     ;
  346.     ; DO NOT include a space after the ; on lines 4 & 5.
  347.     ;
  348.     ; Lines 6+ contain the commands of the batch file, including comments.
  349.     ;
  350.     echo "*nSample batch file for TagRead*n"
  351.     echo "Message       : [msg]"
  352.     echo "User_Name     : [user]"
  353.     echo "Area Number   : [anum]"
  354.     echo "Message Number: [mnum]"
  355.     echo "Area Name     : [aname]"
  356.     echo "Port          : [port]*n"
  357.  
  358.  
  359. Other Notes
  360. ~~~~~~~~~~~
  361. TurboRead doesn't like ANSI in messages. It won't crash or anything, but a
  362. message with ANSI will look a mess when read.
  363.  
  364. The To, From, and Title fields are truncated as necessary. There is only so
  365. much room on one 80 col screen!  They are shown in full in the message
  366. header when reading a message.
  367.  
  368.  
  369. The Legal Stuff
  370. ~~~~~~~~~~~~~~~
  371. This program is PD. I accept no responsibility (legal or otherwise) for
  372. the performace or lack thereof of TurboRead.  Use it at your own risk.
  373.  
  374. I have tested and debugged TurboRead pretty well, so you shouldn't have
  375. any problems, but if you do, let me know!
  376.  
  377.  
  378. Contacting Me
  379. ~~~~~~~~~~~~~
  380. If you have bug reports, comments, suggestions, ideas, complaints, or praise :)
  381. I can be reached at:
  382.  
  383.    Bob Stouder                          BBS:     (513) 860-5150 V32bis
  384.    8165 Mellowtone Ct                   FIDO:     1:108/150
  385.    W. Chester OH, 45069                 AmigaNet: 40:706/40  40:706/1
  386.  
  387.  
  388. You can always FREQ the lastest version of TurboRead with the magic name of
  389. TURBOREAD from my BBS.
  390.